Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove references to non-existant functions in the std::path documentation #16061

Closed
wants to merge 1 commit into from
Closed

Remove references to non-existant functions in the std::path documentation #16061

wants to merge 1 commit into from

Conversation

nham
Copy link
Contributor

@nham nham commented Jul 28, 2014

Two methods for GenericPath reference functions (to_display_str and to_filename_display_str) which appear to no longer exist. The only reference I was able to find for these was a commit message for a commit in September 2013.

lilyball
lilyball reviewed Jul 29, 2014
View reviewed changes
src/libstd/path/mod.rs
///
/// This will print the equivalent of `to_filename_display_str()` when used with a {}
/// format parameter. If there is no filename, nothing will be printed.
/// If there is no filename, nothing will be printed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Leave the blank line intact between the summary and this one-sentence description.

@lilyball
Copy link
Contributor

r=me with the comment addressed

@nham
Copy link
Contributor Author

nham commented Jul 29, 2014

Done, though this doesn't seem consistent with the documentation for the other functions. Here's an example:

/// Returns the path as a string, if possible.
/// If the path is not representable in utf-8, this returns None.
#[inline]
fn as_str<'a>(&'a self) -> Option<&'a str> {

@sfackler
Copy link
Member

The other doc blocks are messed up.

@lilyball
Copy link
Contributor

Please squash the two commits together.

@nham
Copy link
Contributor Author

nham commented Jul 29, 2014

Done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@nham @lilyball @sfackler @alexcrichton @bors